ci: open dev-to-main PR instead of pushing protected main#1320
ci: open dev-to-main PR instead of pushing protected main#1320andreidavid wants to merge 1 commit into
Conversation
WalkthroughWorkflow automation updated to replace manual rebasing with automated PR creation from dev to main. Includes logic to check for existing PRs before creating new ones. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/workflows/release-earn-apps.yaml:
- Around line 60-68: The checkout step is not pinned which can mismatch with the
hardcoded head = 'dev' used when creating the PR; update the checkout action
(the step that uses actions/checkout) to include ref: 'dev' so the workspace
actually checks out the dev branch before tagging and PR creation, and leave the
PR creation logic that sets head = 'dev' unchanged; target the checkout step by
its uses: 'actions/checkout' reference and ensure ref: 'dev' is added.
- Around line 86-93: Wrap the github.rest.pulls.create call in a try-catch and
handle HTTP 422 (already_exists) idempotently: catch errors from the create call
(where the code currently does const { data: pr } = await
github.rest.pulls.create({...})), and if err.status === 422, re-query the repo
for the matching PR (e.g., via github.rest.pulls.list with the same
head/base/title) and use the existing PR data instead of failing; for other
errors rethrow or log and fail as appropriate.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting
📒 Files selected for processing (1)
.github/workflows/release-earn-apps.yaml
| - name: Create or reuse PR from dev to main | ||
| uses: actions/github-script@v7 | ||
| with: | ||
| github-token: ${{ github.token }} | ||
| script: | | ||
| const owner = context.repo.owner | ||
| const repo = context.repo.repo | ||
| const head = 'dev' | ||
| const base = 'main' |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
cat -n .github/workflows/release-earn-apps.yamlRepository: OasisDEX/summerfi-monorepo
Length of output: 4721
Checkout must pin to dev or workflow dispatch branch mismatch can cause wrong release.
Workflow can be dispatched from any branch but checkout is not pinned. Line 67 hardcodes head = 'dev' for PR creation, so releasing from main checks out main, tags main, but tries to open PR from dev → main.
Add ref: dev to checkout step.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.github/workflows/release-earn-apps.yaml around lines 60 - 68, The checkout
step is not pinned which can mismatch with the hardcoded head = 'dev' used when
creating the PR; update the checkout action (the step that uses
actions/checkout) to include ref: 'dev' so the workspace actually checks out the
dev branch before tagging and PR creation, and leave the PR creation logic that
sets head = 'dev' unchanged; target the checkout step by its uses:
'actions/checkout' reference and ensure ref: 'dev' is added.
| const { data: pr } = await github.rest.pulls.create({ | ||
| owner, | ||
| repo, | ||
| head, | ||
| base, | ||
| title, | ||
| body, | ||
| }) |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
find . -name "release-earn-apps.yaml" -type fRepository: OasisDEX/summerfi-monorepo
Length of output: 112
🏁 Script executed:
cat -n .github/workflows/release-earn-apps.yaml | sed -n '70,110p'Repository: OasisDEX/summerfi-monorepo
Length of output: 1610
🏁 Script executed:
cat -n .github/workflows/release-earn-apps.yamlRepository: OasisDEX/summerfi-monorepo
Length of output: 4721
🌐 Web query:
GitHub REST API PR creation 422 error when PR already exists
💡 Result:
When you call POST /repos/{owner}/{repo}/pulls to create a PR and GitHub returns 422 Unprocessable Entity, one common cause is that an open PR already exists for the same head → base combination (the API responds with a validation error like “A pull request already exists for owner:branch”) [3]. GitHub documents that this endpoint can return 422 “Validation failed” [1].
GitHub’s REST API does not provide an “idempotent create PR” option (i.e., you can’t ask it to return 201/OK if the PR already exists); you need to handle it in your client by detecting the existing PR and treating that case as success [2].
Practical fix (recommended pattern)
- Before creating, query for an existing PR using List pull requests with
headand (optionally)basefilters:GET /repos/{owner}/{repo}/pulls?state=open&head=OWNER:branch&base=main
GitHub supports filtering PRs byheadinuser:ref-nameformat and bybasebranch name [1].
- If the list returns a PR, reuse its number/URL instead of calling create again.
- Otherwise, call Create a pull request.
This avoids relying on parsing the 422 message, and prevents repeated create attempts that will always fail once a PR exists. [1]
🌐 Web query:
GitHub API pulls.create 422 Unprocessable Entity error conditions
💡 Result:
For POST /repos/{owner}/{repo}/pulls (“pulls.create”), GitHub returns 422 Unprocessable Entity when the request can’t be validated/processed (or the endpoint is being “spammed”). (docs.github.com)
Common 422 causes for creating a pull request:
-
Missing required fields in the JSON body:
headis required (docs.github.com)baseis required (docs.github.com)titleis required unless you supplyissue(andissueis required unless you supplytitle) (docs.github.com)- These typically show up as
"message": "Validation Failed"with an entry inerrors[]likecode: "missing_field". (docs.github.com)
-
Invalid
head(very common):- The branch name doesn’t exist on GitHub (only local / not pushed yet), or
- For a PR from a fork,
headmust be namespaced likeusername:branch(otherwise it’s “invalid”). (docs.github.com)
-
Invalid
base:basemust be an existing branch on the current repo, and you can’t target a base branch in a different repository. (docs.github.com)
-
No commits/diffs between
headandbase:- GitHub can reject the PR with a validation error like “No commits between …”. (stackoverflow.com)
-
A PR already exists for the same
head:- Often returned as a
"code": "custom"validation error with a message like “A pull request already exists for …”. (knowledge.broadcom.com)
- Often returned as a
-
GitHub can’t read the refs you referenced (permissions / token scopes):
- Example validation error:
"not all refs are readable", commonly fixed by ensuring the token/app has appropriate Contents: read access. (stackoverflow.com)
- Example validation error:
How to quickly pinpoint which one you hit:
- Inspect the response body’s
errors[]entries (codevalues likemissing_field,invalid,already_exists,unprocessable,custom)—GitHub documents what these codes mean. (docs.github.com)
Citations:
- 1: https://docs.github.com/de/enterprise-cloud%40latest/rest/pulls/pulls
- 2: https://docs.github.com/de/enterprise-cloud%40latest/rest/pulls/pulls
- 3: https://docs.github.com/de/enterprise-cloud%40latest/rest/pulls/pulls
- 4: https://docs.github.com/de/enterprise-cloud%40latest/rest/pulls/pulls
- 5: https://docs.github.com/en/enterprise-server%403.15/rest/using-the-rest-api/troubleshooting-the-rest-api?utm_source=openai
- 6: https://docs.github.com/de/enterprise-cloud%40latest/rest/pulls/pulls
- 7: https://docs.github.com/de/enterprise-cloud%40latest/rest/pulls/pulls
- 8: https://stackoverflow.com/questions/51737652/creating-github-pull-request-from-android-studio-gives-error?utm_source=openai
- 9: https://knowledge.broadcom.com/external/article/384130/unable-to-pull-request-from-github-enter.html?utm_source=openai
- 10: https://stackoverflow.com/questions/63423099/pygithub-create-pull-request-githubexception-not-all-refs-are-readable?utm_source=openai
- 11: https://docs.github.com/en/enterprise-server%403.15/rest/using-the-rest-api/troubleshooting-the-rest-api?utm_source=openai
Handle concurrent PR creation to prevent 422 errors.
The list check at lines 72-84 doesn't prevent the race condition when two workflow runs execute concurrently and both pass the check before either creates the PR. Add try-catch on 422 to handle idempotently.
Suggested fix
- const { data: pr } = await github.rest.pulls.create({
- owner,
- repo,
- head,
- base,
- title,
- body,
- })
-
- core.info(`Created PR: #${pr.number} ${pr.html_url}`)
+ try {
+ const { data: pr } = await github.rest.pulls.create({
+ owner,
+ repo,
+ head,
+ base,
+ title,
+ body,
+ })
+ core.info(`Created PR: #${pr.number} ${pr.html_url}`)
+ } catch (error) {
+ if (error.status === 422) {
+ core.info('PR already exists; skipping.')
+ return
+ }
+ throw error
+ }📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const { data: pr } = await github.rest.pulls.create({ | |
| owner, | |
| repo, | |
| head, | |
| base, | |
| title, | |
| body, | |
| }) | |
| try { | |
| const { data: pr } = await github.rest.pulls.create({ | |
| owner, | |
| repo, | |
| head, | |
| base, | |
| title, | |
| body, | |
| }) | |
| core.info(`Created PR: #${pr.number} ${pr.html_url}`) | |
| } catch (error) { | |
| if (error.status === 422) { | |
| core.info('PR already exists; skipping.') | |
| return | |
| } | |
| throw error | |
| } |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.github/workflows/release-earn-apps.yaml around lines 86 - 93, Wrap the
github.rest.pulls.create call in a try-catch and handle HTTP 422
(already_exists) idempotently: catch errors from the create call (where the code
currently does const { data: pr } = await github.rest.pulls.create({...})), and
if err.status === 422, re-query the repo for the matching PR (e.g., via
github.rest.pulls.list with the same head/base/title) and use the existing PR
data instead of failing; for other errors rethrow or log and fail as
appropriate.
1 participant
Description
This PR updates the release-earn-apps workflow to stop failing on protected main by creating/reusing a dev -> main PR instead of pushing directly to main.
Changes
Benefits
Testing
Next steps
Additional Notes
This PR is intentionally scoped to branch-protection compatibility in release-earn-apps; other previously merged workflow improvements are not reintroduced here.
Please review and provide any feedback or suggestions for improvement.
Summary by CodeRabbit